LotusScript Doc

Class: LSAAddressData

Container for the class LSAAddressData

Version:
1.2.4, 13.SEP.2000
History:
26.JUL.2000RGRpassing values down to phone number list
25.JUL.2000RGRdefaultData bugfix of customer data integration
31.MAY.2000RGRmethod saveToPredefined fields changed for performance reasons
13.SEP.2000ggdelete subobjects (like PhoneNumberS) if a new object is set via property



Property Summary
Public Property Set AddrDataID As String
Public Property Get AddrDataID As String
Public Property Get ContactSearchCriterias As Variant
Public Property Get DefaultData As String
Public Property Set EMailAddresseS As LSAEMailAddresseS
Public Property Get EMailAddresseS As LSAEMailAddresseS
Public Property Set ItemDelimiter As String
Public Property Get ItemDelimiter As String
Public Property Set ListDelimiter As String
Public Property Get ListDelimiter As String
Public Property Set MainDelimiter As String
Public Property Get MainDelimiter As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Get OrganizationSearchCriterias As Variant
Public Property Get ParentUnit As Variant
Public Property Set ParentUnitID As String
Public Property Get ParentUnitID As String
Public Property Set PhoneNumberS As LSAPhoneNumbers
Public Property Get PhoneNumberS As LSAPhoneNumberS
Public Property Set PostalAddresseS As LSAPostalAddresseS
Public Property Get PostalAddresseS As LSAPostalAddresseS
Public Property Set WebPageS As LSAWebPageS
Public Property Get WebPageS As LSAWebPageS

Method Summary
Sub Delete ()
Sub fillFromDoc (doc As NotesDocument)
Function hasAttributeChanged (attrName As String) As Integer
Function hasChanged () As Integer
Sub New (unitID As String)
Function saveToPredefinedFields (doc As NotesDocument) As Integer
Sub SaveToResponses (doc As NotesDocument)

Property Detail

Public Property Set ParentUnitID AsString

Summmary Top

Public Property Get ParentUnitID AsString

Summmary Top

Public Property Set AddrDataID AsString

Summmary Top

Public Property Get AddrDataID AsString

Summmary Top

Public Property Get ParentUnit AsVariant

If the property AddressDataID is set to an correct Instance ID of the LSAAddressData object which can be obtained by the instance manager class this property returns a handle to object.

Summmary Top

Public Property Set EMailAddresseS AsLSAEMailAddresseS

Sets the email addresses of the LSAAddressData

History:
13.SEP.2000ggdelete subobject if a new object is set via property
Summmary Top

Public Property Get EMailAddresseS AsLSAEMailAddresseS

Summmary Top

Public Property Set PhoneNumberS AsLSAPhoneNumbers

Sets the phone numbers of the LSAAddressData

History:
26.JUL.2000RGRID of this object is passed to phone number list
13.SEP.2000ggdelete subobject if a new object is set via property
Summmary Top

Public Property Get PhoneNumberS AsLSAPhoneNumberS

Summmary Top

Public Property Set WebPageS AsLSAWebPageS

Sets the web pages of the LSAAddressData

History:
13.SEP.2000ggdelete subobject if a new object is set via property
Summmary Top

Public Property Get WebPageS AsLSAWebPageS

Summmary Top

Public Property Set PostalAddresseS AsLSAPostalAddresseS

Sets the postal addresses of the LSAAddressData

History:
13.SEP.2000ggdelete subobject if a new object is set via property
Summmary Top

Public Property Get PostalAddresseS AsLSAPostalAddresseS

Summmary Top

Public Property Get ContactSearchCriterias AsVariant

Summmary Top

Public Property Get OrganizationSearchCriterias AsVariant

Summmary Top

Public Property Set MainDelimiter AsString

When the object is imploded to a serial data string this character is used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get MainDelimiter AsString

Summmary Top

Public Property Set ListDelimiter AsString

When the object is imploded to a serial data string this character is used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ListDelimiter AsString

Summmary Top

Public Property Set ItemDelimiter AsString

When the object is imploded to a serial data string this character is used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ItemDelimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to use in the postal address properties which are used in the serial format

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top

Public Property Get DefaultData AsString

Summmary Top
Method Detail

New

Public Sub New(unitID As String)
Creates a LSAAddressData object by using the interfaces of the unit whose instance ID is passed in as parameter.

Parameters:
unitIDStringthe ID with which the unit is registered in the instance manager @histroy 26.JUL.2000 ID of this object is passed to the LSAPhoneNumbersClass
Summmary Top

Delete

Public Sub Delete
Default destructor of the class. Deletes all child objects.

History:
08.JUN.2000RGRChild objects are deleted.
Summmary Top

saveToPredefinedFields

Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Saves the properties DefaultValue, ContactSearchCriterias and OrganizationSearchCriterias and calls the saveToPredefiendFieldsMethods of the maintained lists (phonenumbers, webpages, postaladdresses and emailaddresses).

Returns:
true, if one field of the document is different to an attribute of the classes
History:
31.MAY.2000RGRtemporary variable used to call function ContactSearchCriterias only once (ContactSearchCriterias uses getDisplayName of class LSAAddressUnit which is performance intensive)
Summmary Top

SaveToResponses

Public Sub SaveToResponses(doc As NotesDocument)
Tears off the property saveToResponses of the class LSAPostalAddresses. If other information should be saved in response documents, this is the place to make the save process happen.

Summmary Top

hasAttributeChanged

Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has changed. Returns true if it has changed. If the attribute hasn't changed or the attribute cannot be located false is returned.

Returns:
Booleantrue, if the attribute has changed
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks if one of the attributes has been changed

Returns:
Booleantrue, if an attribute has changed
Summmary Top

fillFromDoc

Public Sub fillFromDoc(doc As NotesDocument)
Reads values from disk to be able to fill objects like the EmailAddresseS and to compare if something has changed

Parameters:
docNotesDocumentdocument which is source for the object attributes
Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:40:01 AM